Switch from the long forsaken Travis CI build to using GitHub Actions#139
Merged
fizyk20 merged 3 commits intofizyk20:masterfrom Apr 28, 2023
Merged
Switch from the long forsaken Travis CI build to using GitHub Actions#139fizyk20 merged 3 commits intofizyk20:masterfrom
fizyk20 merged 3 commits intofizyk20:masterfrom
Conversation
Collaborator
|
@fizyk20 will need to do this, as I don't have the ability to enable the write permission. Otherwise, looks good to me. |
Collaborator
|
Running the tests with Miri (only) would be good as well. |
Contributor
Author
|
I added a step for running the tests with Miri. |
Collaborator
|
I think the only build/test step should be |
Contributor
Author
|
Alright. In my own projects I would want to run my code on both real hardware and in the Miri interpreter, out of an abundance of caution, but 10-4. 😄 |
Owner
|
As far as I can tell, the relevant setting is already set correctly, so I'm merging this PR. Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I was thinking that in the spirit of an upcoming 1.0 release, it'd be useful to have a proper CI setup back up and running. So that's what this PR provides!
You can see a sample run of this action in my forked repo. In addition to providing CI (both for master branch and for PRs), this action also publishes docs to the repo's GH pages branch (only on pushes to the master branch), ensuring that the documentation link in the README doesn't keep getting more and more outdated. Here's the latest copy of the docs as automatically generated and pushed to my fork by this very GH Actions setup.
Setting this whole thing up even let me discover a mistake in the
impl_zeroize.rsfile that had gone unnoticed without CI.In order for the documentation to be published successfully, the
GITHUB_TOKENmust be given write permissions to the repo, otherwise it can't push to thegh-pagesbranch. The CI.yml file should be simple enough to vet to ensure that I'm not up to anything mischievous, since you otherwise have no obvious reason to trust me. Instructions on how to enable this write permission. You'll want to change this setting before merging this PR if you want the documentation publish to succeed.